| LSTimeFormat |
|
 |
| Description
|
|
Formats the time part of a date/time string into a string in a locale-specific format.
|
| |
| Returns
|
|
A string representing the time value.
|
| |
| Category
|
|
Date and time functions, Display and formatting functions, International functions
|
| |
| Function syntax |
LSTimeFormat(time [, mask ])
|
| |
| See also
|
|
LSParseDateTime, LSDateFormat, TimeFormat
|
| |
| History
|
|
ColdFusion MX 6.1: Added the mask character L or l to represent milliseconds.
|
ColdFusion MX:
- Changed formatting behavior: this function might return different formatting than in earlier releases. This function uses Java standard locale formatting rules on all platforms.
- Added support for the following mask attribute options: short, medium, long, and full.
|
| |
| Parameters
|
| |
| Parameter |
Description |
| string |
A date/time value |
| |
A string that is convertible to a time value |
| |
A date/time object is in the range 100 AD–9999 AD. |
| mask |
Masking characters that determine the format: |
| |
h: Hours; no leading zero for single-digit hours (12-hour clock) |
| |
hh: Hours; leading zero for single-digit hours. (12-hour clock) |
| |
H: Hours; no leading zero for single-digit hours (24-hour clock) |
| |
HH: Hours; leading zero for single-digit hours (24-hour clock) |
| |
m: Minutes; no leading zero for single-digit minutes |
| |
mm: Minutes; leading zero for single-digit minutes |
| |
s: Seconds; no leading zero for single-digit seconds |
| |
ss: Seconds; leading zero for single-digit seconds |
| |
l: Milliseconds |
| |
t: One-character time marker string, such as A or P. |
| |
tt: Multiple-character time marker string, such as AM or PM |
| |
The following conform to Java locale-specific time encoding standards. Their exact |
| |
formats depend on the locale: |
| |
short: includes hours, minutes; may include AM or PM |
| |
medium: includes hours, minutes; may include AM or PM |
| |
long: medium plus time zone |
| |
full: long, may also include an hour designator |
| |
Default: short |
|
| |
| Usage
|
|
This function uses Java standard locale formatting rules on all platforms.
|
|
When passing date/time value as a string, enclose it in quotation marks. Otherwise, it is interpreted as a number representation of a date/time object.
|
|
To calculate a difference between time zones, use the GetTimeZoneInfo function.
|
|
To set the default display format of date, time, number, and currency values, use the SetLocale function.
|
|
If no seconds value is passed to this function, and the mask value is s, the default output seconds format is one zero; for example, lstimeformat(6:39, "h:m:s") returns 6:39:0. If the mask value is ss, it returns 6:39:00.
|
| |
Example<h3>LSTimeFormat Example</h3>
<p>LSTimeFormat returns a time value using the locale convention.
<!--- loop through a list of locales and show time values --->
<cfloop LIST = "#Server.Coldfusion.SupportedLocales#"
index = "locale" delimiters = ",">
<cfset oldlocale = SetLocale(locale)>
<cfoutput><p><B><I>#locale#</I></B><br>
#LSTimeFormat(Now())#<br>
#LSTimeFormat(Now(), `hh:mm:ss')#<br>
#LSTimeFormat(Now(), `hh:mm:sst')#<br>
#LSTimeFormat(Now(), `hh:mm:sstt')#<br>
#LSTimeFormat(Now(), `HH:mm:ss')#<br>
<hr noshade>
</cfoutput>
</cfloop>
|